3.7.1. New CMP Web Services
3.7.1.1. Activate Subscription Web Service
To support a two-phase subscription sign-up and registration process whereby a sign-up for mobile service and the activation of the subscription following registration occur at different times, a new API is provided that allows a pre-created subscription to be completed in CMP and provisioned on the network.
3.7.1.2. Subscription Web Services
A new Update Subscription web service has been added to allow certain details for a subscription to be updated, namely user name , password, date of birth, gender, marital status and cost centre.
A new Disconnect Subscription web service has been added to allow a subscription to be disconnected from an external system.
The disconnection can be immediate or scheduled for a future date.
A Cancel Disconnection web service has also been added to enable a pending disconnection for a subscription to be cancelled.
Typically, this web service would be used where there is a future disconnection pending and the subscription has changed their mind.
In order to support the retrieval of any charges a subscriber would be liable for prior to disconnection, a new Get Termination Fees web service has been added to return the termination fees a subscription would have to pay based on what date they wish to terminate on.
3.7.1.2.1 Subscription Services
An Add Subscription Service web service has been added that adds a one-off or recurring service to a subscription.
An Update Subscription Service has also been added to expire a recurring service on a subscription. Note, the service to be expired cannot be part of a package.
3.7.1.2.2 Subscription Attributes
A Create Subscription Attribute web service has been added that allows a subscription attribute to be created against the subscription and a value set for it.
An Update Subscription Attribute has also been added to allow subscription attribute values to be updated.
3.7.1.2.3 Subscription Email Addresses
A Get Subscription Email Addresses web service has been added that retrieves all email addresses registered against the subscription.
An Update Subscription Email Address web service has also been added to update the email address registered against the subscription.
3.7.1.3 Change Price Plan
A new web service, Change Price Plan has been added to allow the current price plan on a subscription to be changed to another compatible price plan.
The price plan change can be scheduled immediately or at some future date.
A price plan change is not possible if the subscription is disconnected or if the subscription is part of an agreement price plan.
A plan change is also prevented if the associated agreement has had its bill cycle changed and is not yet on the new bill cycle.
Where the subscription has an active contract then the price plan change cannot take effect on or before the end of the early upgrade period or before the notice period ends.
3.7.1.4 Change Serial Numbers
A new web service, Change Serial Numbers has been added to change a subscription's managed and non-managed serial numbers.
An array of managed and non-managed serial numbers can be provided as part of the request.
3.7.1.5. Account Email Addresses Web Services
A Get Account Email Addresses web service has been added that retrieves all email addresses registered against an account.
An Update Account Email Address web service has also been added to update the email address registered against the account.
3.7.1.6. Direct Debit Web Services
Three new web services have been created to support the creation and management of direct debits:
- Add Direct Debit Details - POST request to add new direct debit details to the account or change existing direct debit details.
New direct debit details can only be added to accounts that have a manual payment method.
If the account has an existing direct debit then cancellation details are required for the existing direct debit before a new one can be added
- Cancel a Direct Debit - POST request to cancel the direct debit payment method on the account. The account will be automatically put on a manual payment method.
3.7.1.7. Registered Card Web Services
Three new web services have been created to support the query and management of registered cards held against an account:
- Get Registered Cards - GET request to retrieve all cards registered against an account
- Update Registered Card - PATCH request to associate a credit/debit card registered against an account with a subscription on that account
- Cancel Registered Card - POST request to cancel a credit/debit card registered against an account.
3.7.1.8 One-time Password
Two new web services have been added to support the generation, and subsequent verification, of a one-time password that can be sent to a subscriber to validate an action through an external system such as a mobile app.
The Generate One-time Password web service allows a one-time password (OTP) to be generated for a subscription or an account and for that password to be issued via an SMS or push notification for example.
The Verify One-time Password web service allows an OTP, entered by an end user, to be verified against the OTP sent to them.
3.7.1.9. Agreement Web Services
A new web service, Update Agreement has been added to update an agreement's bill cycle and/or billing media. Updating the bill cycle forces a bill cycle change on the agreement.
3.7.1.10. Contact Details Web Service
A new web service, Update Contact Details has been added to allow contact and address details to be updated.
The web service supports update of personal details, business details, address details and contact details.
Validation is provided to ensure contact and address details cannot be erased.
3.7.1.11. Compatible Products Web Services
New web services have been added to allow compatible price plans and compatible packages to be returned for a specific subscription.
The Get Compatible Price Plans web service provides a list of price plans that a subscriber can change to based on the current price plan they are on.
The Get Compatible Packages web service provides a list of one-off and recurring bolt-ons that a subscriber can subscribe to based on the current price plan they are on or that they are changing to.
3.7.1.12. Workflow Web Service
A new Create Workflow web service has been added to support the creation of a workflow event against a CMP hierarchical entity.
3.7.2. Changed CMP Web Services
3.7.2.1. Subscription Web Services
The GET Subscriptions and GET Subscription web services have been updated to return the base package details of the subscription.
In addition, the GET Subscriptions web service has been update to support additional query parameters (filters).
It is now possible to query for subscriptions based on a specific non-managed serial number value and also by the identity type and value held against a subscription.
The meta data of the response object has been updated to show the number of subscriptions returned in the response (recordCount) and of those, the number that are currently active in CMP (activeRecordCount).
3.7.2.2. Subscription Spend Cap Web Service
The response object of the GET Subscription Spend Cap web Service has been modified to include the type of cap (Partial or full).
3.7.2.3. Allowance Web Service
The Get Allowances web service has been modified to add the purchase identifier to the response object.
This allows the distinction to be made between bolt-on and base packages (base packages don't have a purchase identifier associated with them).
3.7.2.4. Account Web Services
The response object of the Get Account web service has been updated to return the mandate received date and direct debit setup method code within the bankPayment container for direct debit customers.
3.7.2.5. Registered Card Web Service
The GET Registered Card web service has been updated as follows:
- The accountNumber element in the request body has been deprecated as the accountId path variable is used instead for the request
- The response object has been updated to return details of the card that has been created against account.